/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) [2020-2021] Payara Foundation and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/main/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at legal/OPEN-SOURCE-LICENSE.txt.
 *
 * GPL Classpath Exception:
 * The Payara Foundation designates this particular file as subject to the "Classpath"
 * exception as provided by the Payara Foundation in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package fish.payara.microprofile.openapi.test.app.application;

import com.fasterxml.jackson.databind.JsonNode;
import fish.payara.microprofile.openapi.impl.visitor.OpenApiWalker;
import fish.payara.microprofile.openapi.test.app.OpenApiApplicationTest;
import fish.payara.microprofile.openapi.test.util.JsonUtils;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import org.eclipse.microprofile.openapi.annotations.media.Content;
import org.eclipse.microprofile.openapi.annotations.media.Schema;
import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import org.junit.Test;

/**
 * Testcase for Github issue #4334 where @Schema annotation not scanned if class
 * file exist in external jar.
 *
 * In this test case {@link OpenApiWalker#allTypes} include TestApplication,
 * ExternalSchemaExampleTest, and Student classes. And the
 * {@link OpenApiWalker#allowedTypes} include TestApplication, and
 * ExternalSchemaExampleTest classes. The {@link StudentDTO} class is dynamically
 * picked from {@link OpenApiWalker#allTypes} for the Schema annotation scanning
 * from metadata processor..
 *
 */
@Path("/students")
public class ExternalSchemaExampleTest extends OpenApiApplicationTest {

    @GET
    @APIResponse(
            description = "Get the Student information",
            content = @Content(
                    mediaType = "application/json",
                    schema = @Schema(implementation = StudentDTO.class)
            )
    )
    public StudentDTO getStudent() {
        return new StudentDTO();
    }

    @Test
    public void fieldSchemaExampleIsRendered() {
        JsonNode nameProperties = JsonUtils.path(getOpenAPIJson(), "components.schemas.Student.properties.name");
        assertNotNull(nameProperties);
        assertEquals("string", nameProperties.get("type").textValue());
        assertEquals("the student name", nameProperties.get("description").textValue());
        assertEquals("cuba", nameProperties.get("example").textValue());
    }
}

@Schema(name = "Student", description = "POJO that represents a Student.")
class StudentDTO {

    @Schema(name = "name", description = "the student name", example = "cuba")
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

